﻿
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<!-- saved from url=(0014)about:internet -->
<html xmlns:msxsl="urn:schemas-microsoft-com:xslt" xmlns:mssdk="winsdk" xmlns:script="urn:script" xmlns:build="urn:build" xmlns:MSHelp="http://msdn.microsoft.com/mshelp">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8"/>
<meta name="Description" content="The .foreach token parses the output of one or more debugger commands and uses each value in this output as the input to one or more additional commands."/>
<meta name="MSHAttr" content="PreferredSiteName:MSDN"/>
<meta name="MSHAttr" content="PreferredLib:/library/windows/hardware"/>
<title>.foreach</title>

<meta name="MS-HAID" content="r14_tokens_edf3a785-a32a-495f-be5c-364833d77aa6.xml"/>


<link rel="STYLESHEET" type="text/css" HREF="../common/backsdk4.css"/>





<style>
html,div { margin: 0; padding: 0;}

body {
	padding: 0px;
	margin: 0px;
	overflow: auto;
	height: 100%;
}

#winchm_template_button{
	float: right;
	width: 93px;
	top: 7px;
	position: relative;
	text-align: right;
	right: 5px;
	height: auto;
}

#winchm_template_top{
	padding: 0px;
	margin: 0px;
	border-bottom: 1px solid #9B9B9B;
	background-color: #B1CEFE;
}

#winchm_template_navigation{
	margin: 0px;
	padding-top: 7px;
	padding-left: 7px;
	padding-bottom: 3px;
	padding-right: 0px;
	font-size: 8.5pt;
	font-family: Arial, Helvetica, sans-serif;
	font-weight: normal;
	color: #585858;
}

#winchm_template_title{
	margin: 0px;
	padding-top: 4px;
	padding-left: 7px;
	padding-bottom: 7px;
	padding-right: 0px;
	font-size: 18px; 
	font-family: Verdana, Geneva, sans-serif;
	color: #363636;
}

#winchm_template_content{
	margin-top: 20px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	width: auto  !important;
	width: 100%;
}

#winchm_template_footer{
	border-width: 1px;
	border-color: #B1CEFE;
	border-top-style: solid;
	margin-top: 15px;
	margin-left: 15px;
	margin-bottom: 20px;
	margin-right: 15px;
	padding-top: 7px;
	padding-left: 0px;
	padding-bottom: 0px;
	padding-right: 0px;
	font-family: arial, helvetica, sans-serif;
	font-size: 8.5pt;
	color: #696969;
	width: auto;
	text-align: left;
}


#winchm_template_container{
	margin: 0px;
	padding: 0px;
	position: static;
	padding-bottom: 3px;
	overflow: auto;
	background-color: #FFFFFF;
}


@media print
{
#winchm_template_container{
	position: static;	
	margin: 0px;
	padding: 5px;
	
	width: auto;
	height: auto;
	overflow: auto;
}
#winchm_template_button{
visibility:hidden;
}
}

#winchm_template_navigation A:link	{text-decoration: none; color:#004080}
#winchm_template_navigation A:visited  {text-decoration: none; color: #004080}
#winchm_template_navigation A:active {text-decoration: none; color: #004080 }
#winchm_template_navigation A:hover {text-decoration: none;color: #0080FF}

A:link	{text-decoration: underline; color:#0033CC}
A:visited  {text-decoration: underline; color: #0033CC}
A:active {text-decoration: underline; color: #0033CC }
A:hover {text-decoration: underline;color: #FF0000;}
</style>
<script type="text/javascript">
function isMobile(){
Agent = window.navigator.userAgent;
if (Agent.indexOf("iPhone")>=1 || Agent.indexOf("iPad")>=1 || Agent.indexOf("iPod")>=1 || Agent.indexOf("Android")>=1){
return true;
}else{
return false;	
}

}
function d_onresize(){
if (window.navigator.userAgent.indexOf("MSIE")>=1){
document.getElementById('winchm_template_container').style.pixelWidth = document.body.offsetWidth - 3;
document.getElementById('winchm_template_container').style.pixelHeight = document.body.offsetHeight - document.getElementById('winchm_template_top').offsetHeight - 4;
}
document.getElementById('winchm_template_container').style.top = document.getElementById('winchm_template_top').offsetHeight + 'px';
}

function d_onbeforeprint(){
document.getElementById('winchm_template_container').style.width = 'auto';
document.getElementById('winchm_template_container').style.height = 'auto';
}

function d_onafterprint(){
d_onresize();
}

if(!isMobile()){

window.onload = d_onresize;
window.onresize = d_onresize;
window.onbeforeprint = d_onbeforeprint;
window.onafterprint = d_onafterprint;

document.write("<style>\n");
document.write("body {overflow: hidden;}\n");
document.write("#winchm_template_container {position: absolute;overflow: auto;top : 0px;right: 0px;bottom: 0px;left: 0px;}\n");
document.write("</style>\n");
}

</script>
</head>
<body><script language="JavaScript" type="text/JavaScript">
function syn(){
if(parent.nav.tree){
 if(parent.nav.tree.loaded){
  parent.nav.tree.selectNode(1946);
 }else{
  setTimeout("syn()",500);
}
  }else{
  setTimeout("syn()",500);
  }}
if(parent!=self){
  setTimeout("syn()",100);
}else{
  parent.location.href = "../../index.htm?page=debugger/_foreach.htm";
}
originalOnload = window.onload;
if(originalOnload==null){
window.onload = function(){parent.contentLoaded = true;};
}else{
window.onload = function(){originalOnload();parent.contentLoaded = true;};
}
</script> 


<div id="winchm_template_top">
	<div id="winchm_template_button"><A href="_for.htm" title="Previous topic"><img id="winchm_template_prev" alt="Previous topic" src="../template2/btn_prev_n.gif" border="0"></a><A href="_if.htm" title="Next topic"><img id="winchm_template_next" alt="Next topic" src="../template2/btn_next_n.gif" border="0"></a></div>
	<div id="winchm_template_navigation">Help &gt; 
<A href="introduction6.htm">Debugging Tools for Windows (WinDbg, KD, CDB, NTSD)</A> &gt; <A href="debugger_reference.htm">Debugger Reference</A> &gt; <A href="debugger_commands.htm">Debugger Commands</A> &gt; <A href="command_tokens.htm">Command Tokens</A> &gt; </div>
	<div id="winchm_template_title">.foreach</div>
</div>
<div id="winchm_template_container">
	<div id="winchm_template_content"><div id="mainSection"><p>The <b>.foreach</b> token parses the output of one or more debugger commands and uses each value in this output as the input to one or more additional commands.</p>
<pre class="syntax">
<b>.foreach </b>[<i>Options</i>]<b> ( </b><i>Variable</i><b>  { </b><i>InCommands</i><b> } ) { </b><i>OutCommands</i><b> }</b> 

<b>.foreach </b>[<i>Options</i>]<b> /s ( </b><i>Variable</i><b>  "</b><i>InString</i><b>" ) { </b><i>OutCommands</i><b> }</b> 

<b>.foreach </b>[<i>Options</i>]<b> /f ( </b><i>Variable</i><b>  "</b><i>InFile</i><b>" ) { </b><i>OutCommands</i><b> }</b> 
</pre>
<h2><a id="ddk_token_foreach_dbg"></a><a id="DDK_TOKEN_FOREACH_DBG"></a>Syntax Elements</h2>
<p></p>
<dl>
<dt><a id="_______Options______"></a><a id="_______options______"></a><a id="_______OPTIONS______"></a>       <i>Options</i>      </dt>
<dd>
<p>Can be any combination of the following options:</p>
<p></p>
<dl>
<dt><a id="_pS_InitialSkipNumber"></a><a id="_ps_initialskipnumber"></a><a id="_PS_INITIALSKIPNUMBER"></a><b>/pS </b><i>InitialSkipNumber</i></dt>
<dd>
<p>Causes some initial tokens to be skipped.  <i>InitialSkipNumber</i> specifies the number of output tokens that will not be passed to the specified <i>OutCommands</i>.</p>
</dd>
<dt><a id="_ps_SkipNumber"></a><a id="_ps_skipnumber"></a><a id="_PS_SKIPNUMBER"></a><b>/ps </b><i>SkipNumber</i></dt>
<dd>
<p>Causes tokens to be skipped repeatedly each time a command is processed.  After each time a token is passed to the specified <i>OutCommands</i>, a number of tokens equal to the value of <i>SkipNumber</i> will be ignored.</p>
</dd>
</dl>
</dd>
<dt><a id="_______Variable______"></a><a id="_______variable______"></a><a id="_______VARIABLE______"></a>       <i>Variable</i>      </dt>
<dd>
<p>Specifies a variable name. This variable will be used to hold the output from each command in the <i>InCommands</i> string; you can reference <i>Variable</i> by name in the parameters passed to the <i>OutCommands</i>. Any alphanumeric string can be used, although using a string that can also pass for a valid hexadecimal number or debugger command is not recommended. If the name used for <i>Variable</i> happens to match an existing global variable, local variable, or alias, their values will not be affected by the <b>.foreach</b> command.</p>
</dd>
<dt><a id="_______InCommands______"></a><a id="_______incommands______"></a><a id="_______INCOMMANDS______"></a>       <i>InCommands</i>      </dt>
<dd>
<p>Specifies one or more commands whose output will be parsed; the resulting tokens will be passed to <i>OutCommands</i>. The output from <i>InCommands</i> is not displayed.</p>
</dd>
<dt><a id="_______InString______"></a><a id="_______instring______"></a><a id="_______INSTRING______"></a>       <i>InString</i>      </dt>
<dd>
<p>Used with <b>/s</b>.  Specifies a string that will be parsed; the resulting tokens will be passed to <i>OutCommands</i>.</p>
</dd>
<dt><a id="_______InFile______"></a><a id="_______infile______"></a><a id="_______INFILE______"></a>       <i>InFile</i>      </dt>
<dd>
<p>Used with <b>/f</b>.  Specifies a text file that will be parsed; the resulting tokens will be passed to <i>OutCommands</i>. The file name <i>InFile</i> must be enclosed in quotation marks.</p>
</dd>
<dt><a id="_______OutCommands______"></a><a id="_______outcommands______"></a><a id="_______OUTCOMMANDS______"></a>       <i>OutCommands</i>      </dt>
<dd>
<p>Specifies one or more commands which will be executed for each token. Whenever the <i>Variable</i> string occurs it will be replaced by the current token.</p>
<div class="alert"><b>Note</b>    When the string <i>Variable</i> appears within <i>OutCommands</i>, it must be surrounded by spaces. If it is adjacent to any other text -- even a parenthesis -- it will not be replaced by the current token value, unless you use the <a href="#Bookmark1935"><b>${ }  (Alias Interpreter)</b></a> token.</div>
<div> </div>
</dd>
</dl>
<h3><a id="Additional_Information"></a><a id="additional_information"></a><a id="ADDITIONAL_INFORMATION"></a>Additional Information</h3>
<p>For information about other control flow tokens and their use in debugger command programs, see <a href="#Bookmark1270">Using Debugger Command Programs</a>.</p>
<h2>Remarks</h2>
<p>When the output from <i>InCommands</i>, the <i>InString</i> string, or the <i>InFile</i> file is parsed, any number of spaces, tabs, or carriage returns is treated as a single delimiter. Each of the resulting pieces of text is used to replace <i>Variable</i> when it appears within <i>OutCommands</i>.</p>
<p>Here is an example of a <b>.foreach</b> statement that uses the <a href="#Bookmark1987"><b>dds</b></a> command on each token found in the file <i>myfile.txt</i>:</p>
<div class="code"><span codelanguage=""><table>
<tr>
<th></th>
</tr>
<tr>
<td>
<pre>0:000&gt; .foreach /f ( place "g:\myfile.txt") { dds place } </pre>
</td>
</tr>
</table></span></div>
<p>The <b>/pS</b> and <b>/ps</b> flags can be used to pass only certain tokens to the specified <i>OutCommands</i>.  For example, the following statement will skip the first two tokens in the <i>myfile.txt</i> file and then pass the third to <a href="#Bookmark1987"><b>dds</b></a>.  After each token that is passed, it will skip four tokens.  The result is that <b>dds</b> will be used with the 3rd, 8th, 13th, 18th, and 23rd tokens, and so on:</p>
<div class="code"><span codelanguage=""><table>
<tr>
<th></th>
</tr>
<tr>
<td>
<pre>0:000&gt; .foreach /pS 2 /ps 4 /f ( place "g:\myfile.txt") { dds place } </pre>
</td>
</tr>
</table></span></div>
<p>For more examples that use the <b>.foreach</b> token, see <a href="#Bookmark1274">Debugger Command Program Examples</a>.</p></div></div>	
	<div id="winchm_template_footer">Copyright &copy; 2019. All rights 
reserved. (To change the copyright info, just edit it in template.)</div>
</div>

</body>
</html>
